Deprecation for zone in favour of explicit zone_id
#421
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
Zone names within Cloudflare are not universally unique which makes performing a lookup based on just the name a little troublesome. Two accounts can have the same zone name and both of these can be returned if the lookups are not restricted to the zone ID or account ID. To rememdy this, `zone` is being deprecated in favour of explicit `zone_id` values. See the discussion[1] on this for full details. Following Terraform's guidelines for deprecations[2], we are putting in a deprecation notice as part of a minor release and then in our next major release, we will actually perform the schema and functionality removal. This update will not prevent people from using `zone` however use will trigger a warning that it's going away and they should migrate themselves. [1]: https://github.com/terraform-providers/terraform-provider-cloudflare/issues/161#issuecomment-441128985 [2]: https://www.terraform.io/docs/extend/best-practices/deprecations.html#provider-attribute-removal
jacobbednarz
force-pushed
the
add-deprecation-for-zone-id
branch
from
af8fe8a to
c75c477
Compare
|
Confirmed this is working for a tested resource. |
patryk
approved these changes
Jul 19, 2019
|
🥽 |
|
Think we've been a bit premature with this. pagerule with zone_id specified: pagerule with both zone and zone_id specified: Looking in resource_cloudflare_page_rule.go, it seems zone is still Required and zone_id is computed (hence the above). We probably shouldn't add deprecation warnings until we can take both the new AND old fields. Maybe set them both to Optional and have a check at least one (or only one if both wouldn't be valid) is set?
|
|
Good catch, @SteveGoldthorpe-Work. We should make |
patryk
added a commit
that referenced
this pull request
Aug 9, 2019
jacobbednarz
added a commit
to jacobbednarz/terraform-provider-cloudflare
that referenced
this pull request
Aug 21, 2019
We have been working to perform some breaking changes in cloudflare#227 and the first attempt at this in cloudflare#421 neglected to allow people to set `zone_id` and action the deprecation notice 🤦 This second attempt has the same goal of deprecating `zone` in favour of explicit `zone_id` however this time I've updated both schema properties to be optional and added some validation in the various `Create` methods to ensure that we get at least one of them during the swap over period. That code can be removed as soon we've cut a breaking change release. Closes cloudflare#439
patryk
pushed a commit
that referenced
this pull request
Aug 22, 2019
We have been working to perform some breaking changes in #227 and the first attempt at this in #421 neglected to allow people to set `zone_id` and action the deprecation notice 🤦 This second attempt has the same goal of deprecating `zone` in favour of explicit `zone_id` however this time I've updated both schema properties to be optional and added some validation in the various `Create` methods to ensure that we get at least one of them during the swap over period. That code can be removed as soon we've cut a breaking change release. Closes #439
boekkooi-lengoo
pushed a commit
to boekkooi-lengoo/terraform-provider-cloudflare
that referenced
this pull request
Feb 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Zone names within Cloudflare are not universally unique which makes
performing a lookup based on just the name a little troublesome. Two
accounts can have the same zone name and both of these can be returned
if the lookups are not restricted to the zone ID or account ID.
To rememdy this,
zoneis being deprecated in favour of explicitzone_idvalues. See the discussion on this for full details.Following Terraform's guidelines for deprecations, we are putting in
a deprecation notice as part of a minor release and then in our next
major release, we will actually perform the schema and functionality
removal. This update will not prevent people from using
zonehoweveruse will trigger a warning that it's going away and they should migrate
themselves.